Skip to content

Document machine-wide resource name uniqueness - #5460

Merged
Jeremy Rose (jeremyrose-viam) merged 4 commits into
viamrobotics:mainfrom
jeremyrose-viam:worktree-resource-name-uniqueness-docs
Oct 27, 2026
Merged

Document machine-wide resource name uniqueness#5460
Jeremy Rose (jeremyrose-viam) merged 4 commits into
viamrobotics:mainfrom
jeremyrose-viam:worktree-resource-name-uniqueness-docs

Conversation

@jeremyrose-viam

@jeremyrose-viam Jeremy Rose (jeremyrose-viam) commented Oct 23, 2026

Copy link
Copy Markdown
Member

Documents the viam-server contract that component and service names must be unique across the whole machine, even across different APIs. Shipped in RDK v1.6.0 (rdk PR 6350, RSDK-14326). Closes DOCS-4939.

  • docs/hardware/configure-hardware.md: new "Resource names" subsection under step 2. States the uniqueness rule, that it includes remote and fragment resources, that builtin is reserved for the default services, and what happens on a collision (local resources are not built along with their dependents; a local resource wins over a remote one, which is hidden).
  • docs/hardware/machine-configuration.md: the name field row says unique across the machine and links to the subsection.
  • docs/hardware/multi-machine/add-a-remote-part.md and overview.md: explain that colliding remote resources are hidden and that a prefix prevents it.
  • docs/monitor/troubleshoot.md: tells readers with a missing resource to search the logs for name collision.

Pre-PR checks (prettier 3.2.5, markdownlint, vale 3.16.0 locally, frontmatter_rules.py, make build-prod) passed before merging current main.

@jeremyrose-viam @claude
Document machine-wide resource name uniqueness (DOCS-4939)
20f8300 
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@jeremyrose-viam
Merge branch 'main' of https://github.com/viamrobotics/docs into work…
1ea7bb1 
…tree-resource-name-uniqueness-docs
@netlify

netlify Bot commented Oct 23, 2026 •
edited
Loading

Copy link
Copy Markdown

✅ Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 3137462
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6adf6f8f4ec64b4c43ac6d09
😎 Deploy Preview https://deploy-preview-5460--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse		 1 paths audited
Performance: 37 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Oct 23, 2026
@elizafarley

Eliza Farley (elizafarley) commented Oct 26, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Docs review: Ready to merge

Documents the machine-wide resource name uniqueness rule from rdk v1.6.0 (rdk#6350). Commit 517a0cb4f fixes everything from the last review: the two-remotes case now says both are hidden, the page notes v1.6.0, and the troubleshooting tip says to search for Resource name. Every claim matches the rdk source.

CI: All required checks passing

Docs health: No regressions. multi-machine/overview.md is no longer weakly linked.

Verified against source (9 claims)
  • Names must be unique across the machine, regardless of API: viamrobotics/rdk robot/impl/resource_manager.go:50-51, 63-64
  • builtin is reserved for the default services: robot/impl/resource_manager.go:53-55, 67-68, 1312
  • Colliding local resources aren't built, and their dependents are unavailable: robot/impl/resource_manager.go:52, 1474; rdk#6350 behavior table
  • Collisions are logged at error level: robot/impl/resource_manager.go:363, 1320, 1334, 1474 (Errorw)
  • Searching the logs for Resource name matches all three messages (local, remote, reserved): robot/impl/resource_manager.go:63, 65, 67
  • A local resource wins its name, and the remote one is hidden from the resource list: robot/impl/resource_manager.go:58-59; resource/resource_graph.go:434 (SimpleNamesWhere)
  • Two remotes with the same name are both hidden: robot/impl/resource_manager.go:58-59
  • A prefix on the remote prevents the collision: robot/impl/resource_manager.go:65-66
  • Applies starting in v1.6.0, including fragment-merged configs: commit e8658cd87 is in tag v1.6.0; rdk#6350 fleet-impact scan of fragment-merged configs

Automated review by Claude. Rerunning the review updates this comment.

@jeremyrose-viam

Jeremy Rose (jeremyrose-viam) commented Oct 26, 2026

Copy link
Copy Markdown
Member Author

The four findings from the automated review are addressed in 517a0cb: both remotes are now stated as hidden (in all three places), the v1.6.0 note is added, the troubleshooting hint searches for Resource name, and the hidden remote is described as hidden from the machine's resource list. The review comment above predates that commit.

@jeremyrose-viam
Jeremy Rose (jeremyrose-viam) merged commit 1755ca0 into viamrobotics:main Oct 27, 2026
13 checks passed
@github-actions

github-actions Bot commented Oct 27, 2026

Copy link
Copy Markdown

🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@elizafarley Eliza Farley (elizafarley) elizafarley approved these changes

Assignees

No one assigned

Labels

safe to build This pull request is marked safe to build from a trusted zone

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jeremyrose-viam @elizafarley @viambot